/**
 * Copyright 2008 Mathias Doenitz, http://lis.to/
 *
 * This file is part of the lis.to java desktop client. The lis.to java desktop client is free software: you can
 * redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * The lis.to java desktop client is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with the lis.to java desktop client.
 * If not, see http://www.gnu.org/licenses/
 */

package listo.utils.caching;

import com.google.inject.ImplementedBy;

/**
 * Provides a very simple cache abstraction.
 */
@ImplementedBy(SimpleCache.class)
public interface Cache<K, V> {
    /**
     * Puts the given key/value pair into the cache.
     *
     * @param key   the key
     * @param value the value
     * @return the previous value for the key or null
     */
    public V put(K key, V value);

    /**
     * Checks whether the cache contains a value for the given key
     * and returns it if present.
     *
     * @param key the key
     * @return the value or null
     */
    public V get(K key);
}
